Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[V1] Add kv cache utils tests. #11513

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[V1] Add kv cache utils tests. #11513

wants to merge 3 commits into from
+241 −0

Conversation

xcnick
Copy link
Contributor

@xcnick xcnick commented Dec 26, 2024

This PR adds unit tests for the kv cache related data structures of V1

@github-actions GitHub Actions
Copy link

👋 Hi! Thank you for contributing to the vLLM project.
Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

joerunde
joerunde reviewed Dec 30, 2024
View reviewed changes
tests/v1/core/test_kv_cache_utils.py Outdated

# Test with an empty list
with pytest.raises(IndexError):
queue = FreeKVCacheBlockQueue([])
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since it's valid to popleft down to an empty queue so that free_list_tail and free_list_head are both None, should the initializer accept an empty list and initialize itself that way, instead of erroring?

This test is good as is, I just think it would be better to change the behavior instead to avoid code that can throw an IndexError

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given it's use cases I don't think it makes sense to accept an empty list. I also don't think we need to test this. Instead, if we want to test the initializer, we should pass a list of blocks and check if the linked list is correctly built.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for reviewing. Since the initializer is already tested in other test cases, I will remove the test for creating an empty queue.

comaniac
comaniac reviewed Dec 30, 2024
View reviewed changes
Copy link
Collaborator

@comaniac comaniac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the unit tests! Could you also add unit tests for the rest functions in kv_cache_uilts.py as well?

tests/v1/core/test_kv_cache_utils.py Outdated

# Test with an empty list
with pytest.raises(IndexError):
queue = FreeKVCacheBlockQueue([])
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given it's use cases I don't think it makes sense to accept an empty list. I also don't think we need to test this. Instead, if we want to test the initializer, we should pass a list of blocks and check if the linked list is correctly built.

@xcnick
Copy link
Contributor Author

xcnick commented Dec 31, 2024

Thanks for the unit tests! Could you also add unit tests for the rest functions in kv_cache_uilts.py as well?

Sure, I will add tests for other functions.

@mergify mergify bot added documentation Improvements or additions to documentation ci/build frontend labels Dec 31, 2024
@xcnick
add more tests
d3a4565 
Signed-off-by: xcnick <[email protected]>
comaniac
comaniac approved these changes Dec 31, 2024
View reviewed changes
Copy link
Collaborator

@comaniac comaniac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@comaniac comaniac added ready ONLY add when PR is ready to merge/full CI is needed and removed documentation Improvements or additions to documentation frontend ci/build labels Dec 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joerunde joerunde joerunde left review comments

@comaniac comaniac comaniac approved these changes

@tlrmchlsmth tlrmchlsmth Awaiting requested review from tlrmchlsmth

@WoosukKwon WoosukKwon Awaiting requested review from WoosukKwon

@DarkLight1337 DarkLight1337 Awaiting requested review from DarkLight1337

@ywang96 ywang96 Awaiting requested review from ywang96

@robertgshaw2-neuralmagic robertgshaw2-neuralmagic Awaiting requested review from robertgshaw2-neuralmagic

@simon-mo simon-mo Awaiting requested review from simon-mo

@njhill njhill Awaiting requested review from njhill

@alexm-neuralmagic alexm-neuralmagic Awaiting requested review from alexm-neuralmagic

@zhuohan123 zhuohan123 Awaiting requested review from zhuohan123

@youkaichao youkaichao Awaiting requested review from youkaichao

Assignees
No one assigned
Labels
ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@xcnick @joerunde @comaniac